org.eclipse.vtp.desktop.projects.core.internals
Class PromptSet

java.lang.Object
  org.eclipse.vtp.desktop.projects.core.internals.VoiceResource
      org.eclipse.vtp.desktop.projects.core.internals.PromptSet

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, ObjectListener, IPromptSet, IVoiceToolsResource

public class PromptSet
extends VoiceResource
implements IPromptSet

This is a concrete implementation of IPromptSet and provides the default behavior of that interface.

Version:

2.0

Author:

Trip Gilman

Constructor Summary

PromptSet(org.eclipse.core.resources.IFile file, IVoiceToolsResource parent)
Creates a new PromptSet in the provided parent resource with the given eclipse file resource.

Method Summary

java.lang.String	getName()
protected java.lang.String	getObjectId() The object id is used by the event system to uniquely identify a project resource.
IVoiceToolsResource	getParent() Returns the parent of this resource.
org.eclipse.core.resources.IFile	getUnderlyingFile()
java.io.InputStream	read() Opens the prompt definition resource and returns an InputStream that will produce the byte contents of the resource.
void	write(java.io.InputStream source, org.eclipse.core.runtime.IProgressMonitor monitor) Requests the contents of the prompt definition resource be replaced with the contents of the given input stream.

Methods inherited from class org.eclipse.vtp.desktop.projects.core.internals.VoiceResource

addRefreshListener, deferEvents, finalize, getAdapter, getProject, processObjectEvent, refresh, removeRefreshListener, resumeEvents

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.vtp.desktop.projects.core.IVoiceToolsResource

addRefreshListener, deferEvents, getProject, refresh, removeRefreshListener, resumeEvents

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Constructor Detail

PromptSet

public PromptSet(org.eclipse.core.resources.IFile file,
                 IVoiceToolsResource parent)

Creates a new PromptSet in the provided parent resource with the given eclipse file resource.

Parameters:

file - The eclipse file resource that contains the prompt definitions

parent - The parent resource

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface IVoiceToolsResource

Returns:

The name of the resource

read

public java.io.InputStream read()
                         throws org.eclipse.core.runtime.CoreException

Description copied from interface: IPromptSet

Opens the prompt definition resource and returns an InputStream that will produce the byte contents of the resource.

Specified by:

read in interface IPromptSet

Returns:

An input stream to the contents of the resource

Throws:

org.eclipse.core.runtime.CoreException - If an error occurs while opening the resource

getParent

public IVoiceToolsResource getParent()

Description copied from interface: IVoiceToolsResource

Returns the parent of this resource. If this is a project resource this function returns this.

Specified by:

getParent in interface IVoiceToolsResource

Returns:

The parent of this resource resource

write

public void write(java.io.InputStream source,
                  org.eclipse.core.runtime.IProgressMonitor monitor)
           throws org.eclipse.core.runtime.CoreException

Description copied from interface: IPromptSet

Requests the contents of the prompt definition resource be replaced with the contents of the given input stream.

Specified by:

write in interface IPromptSet

Parameters:

source - An input stream to the new contents of the prompt definition resource

monitor - The progress monitor to be used to provide user feedback during the storage operation

Throws:

org.eclipse.core.runtime.CoreException - If and error occurs while storing the new prompt definition contents

getObjectId

protected java.lang.String getObjectId()

Description copied from class: VoiceResource

The object id is used by the event system to uniquely identify a project resource. In this fashion, multiple references to the resource can be created and still be notified of events.

Specified by:

getObjectId in class VoiceResource

Returns:

A unique identifier for this resource

getUnderlyingFile

public org.eclipse.core.resources.IFile getUnderlyingFile()

Specified by:

getUnderlyingFile in interface IPromptSet